d払い(随時決済) 決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranDocomo 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
JobCd	jobCd	必須処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字6桁利用金額
Tax	tax	半角数字6桁税送料税送料を指定した場合は、利用金額＋税送料が決済金額となります。
PaymentType	paymentType	半角数字1桁決済タイプ 1：随時決済 ※随時決済を行う場合、必須です。

URL

/payment/EntryTranDocomo.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}

URL

/payment/EntryTranDocomo.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		accessID		半角英数32桁固定取引ID
AccessPass		accessPass		半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranDocomo 決済実行

NTTドコモ社へ決済処理を行い結果を返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
DocomoDisp1	docomoDisp1	全半角40バイトドコモ表示項目1
DocomoDisp2	docomoDisp2	全半角40バイトドコモ表示項目2
DispCompanyName	dispCompanyName	全半角32バイト会社名
DispShopName	dispShopName	全半角32バイト利用店舗名
DispPhoneNumber	dispPhoneNumber	半角数字記号13桁連絡先電話番号
DispMailAddress	dispMailAddress	半角英数記号96桁メールアドレス
DispShopUrl	dispShopUrl	半角英数記号96桁問い合わせURL
DocomoAcceptCode	docomoAcceptCode	必須半角数字12桁ドコモ承諾番号

※ 直接契約加盟店様は、DispCompanyName～DispShopUrlの指定は不要です。

※ DispPhoneNumber～DispShopUrlの設定値の合計バイト数を96バイト以内にしてください。

URL

/payment/ExecTranDocomo.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "docomoAcceptCode": "123456789012"
}

URL

/payment/ExecTranDocomo.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&DocomoAcceptCode=123456789012

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態該当取引の取引状態を返却します。 AUTH：仮売上 CAPTURE：即時売上
TranDate	tranDate	半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
DocomoSettlementCode	docomoSettlementCode	半角数字12桁ドコモ決済番号
CheckString	checkString	半角英数記号32桁改ざんチェック文字列 OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "AUTH",
  "tranDate": "20190225162711",
  "docomoSettlementCode": "411178431948",
  "checkString": "6e72a8518107a9fca81d3afee6972e45"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=AUTH&TranDate=20190225162711&DocomoSettlementCode=411178431948&CheckString=6e72a8518107a9fca81d3afee6972e45

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DocomoCancelReturn 決済キャンセル・返品

決済が完了した取引に対して決済内容のキャンセル・返品を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
CancelAmount	cancelAmount	必須半角数字6桁キャンセル金額
CancelTax	cancelTax	半角数字6桁キャンセル税送料キャンセル金額＋キャンセル税送料をキャンセル金額とします。（1円以上）例）請求525円より全額キャンセルする場合：キャンセル金額には525を設定します請求525円より210円分キャンセルする場合：キャンセル金額には210を設定します

URL

/payment/DocomoCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "100"
}

URL

/payment/DocomoCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=100

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態キャンセル・返品成功時は以下のステータスが返却されます。・CANCEL：キャンセル
Amount	amount	半角数字6桁利用金額利用金額からキャンセル金額を減算した結果を返却します。例）利用金額500円よりキャンセル金額300円 => 利用金額200円
Tax	tax	半角数字6桁税送料税送料からキャンセル税送料を減算した結果を返却します。例）税送料250円よりキャンセル税送料150円 => 税送料100円
CancelAmount	cancelAmount	半角数字6桁キャンセル金額キャンセル金額を返却します。
CancelTax	cancelTax	半角数字6桁キャンセル税送料キャンセル税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL",
  "amount": "0",
  "tax": "0",
  "cancelAmount": "100",
  "cancelTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=100&CancelTax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DocomoSales 実売上

仮売上の決済に対して実売上を行います。尚、実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID	shopID	必須半角数字13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字6桁利用金額
Tax	tax	半角数字6桁税送料利用金額＋税送料が売上金額となります（1円以上） ※合計が0円の場合はエラーとします。 ※オーソリ時より大きい金額の場合はエラーとします。 ※オーソリ時と異なる金額の場合は、指定された金額で売上を確定します。

URL

/payment/DocomoSales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "100"
}

URL

/payment/DocomoSales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=100

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Status	status	現状態実売上成功時は以下のステータスが返却されます。・SALES：実売上実売上失敗時は実売上処理前のステータスが返却されます。
Amount	amount	半角数字6桁利用金額実売上した利用金額を返却します。
Tax	tax	半角数字6桁税送料実売上したを税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "100",
  "tax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=100&Tax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DocomoIncrease 増額

決済が完了した取引に対して決済内容の増額を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
IncreaseAmount	increaseAmount	必須半角数字6桁増加金額
IncreaseTax	increaseTax	半角数字6桁増加税送料増加金額＋増加税送料を増加金額とします。（1円以上）

URL

/payment/DocomoIncrease.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "increaseAmount": "100"
}

URL

/payment/DocomoIncrease.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&IncreaseAmount=100

レスポンス

正常

OrderID	orderID	半角数字記号27桁オーダーID
Status	status	現状態増額成功時は以下のステータスが返却されます。・SALES：実売上・CAPTURE：即時売上
Amount	amount	半角数字6桁利用金額利用金額から増加金額を加算した結果を返却します。
Tax	tax	半角数字6桁税送料税送料から増加税送料を加算した結果を返却します。
IncreaseAmount	increaseAmount	半角数字6桁増加金額増加金額を返却します。
IncreaseTax	increaseTax	半角数字6桁増加税送料増加税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "200",
  "tax": "0",
  "increaseAmount": "100",
  "increaseTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=200&Tax=0&IncreaseAmount=100&IncreaseTax=0

レスポンスパラメータ：異常系

[
    {
        "errCode":"E01",
        "errInfo":"E01040001"
    }
]

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

d払い